Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Add typing hint for src codes #99

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Conversation

Yanqiao4396
Copy link
Contributor

@Yanqiao4396 Yanqiao4396 commented Aug 24, 2022

Your Title

Add typing hint

Description

Add the typing hint for all the I/O of functions in source codes

Linked Issues

closes: #93\

Type of Change

  • Feature
  • Bug fix
  • Documentation

Contributors

Reminder

  • All GitHub Actions should be in a passing state before any pull request is merged.
  • All PRs must be reviewed by at least one team member and one member of the Integration team!
  • Any issues this PR closes are tagged in the description!

@gkapfham
Copy link
Collaborator

Hello @Yanqiao4396 if you want to continue to work on this PR, that would be great!

I encourage you to integrate mypy type checking into the GitHub Actions configuration, if it is not there already, so as to ensure that there is an automated tool to confirm that all of your type checks are correct.

Let's continue the conversation here! I am glad to help out with and/or review this PR as needed.

Thanks!

Add mypy library. Put mypy into lint
check. Choose to ignore importing warning because the project works in
virtual environment
@Yanqiao4396 Yanqiao4396 requested a review from gkapfham September 5, 2022 15:02
Mypy expects to find all the dependencies. However, we are building
on virtual environment, so ignore Mypy
"Library stubs not installed" message
@Yanqiao4396
Copy link
Contributor Author

The Mypy is added successfully. The related changes pass!!

@gkapfham gkapfham marked this pull request as draft September 6, 2022 22:02
@gkapfham gkapfham added the enhancement New feature or request label Sep 6, 2022
@gkapfham gkapfham changed the title Add typing hint for src codes WIP: Add typing hint for src codes Sep 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add type hints
2 participants